Skip to content

Create CONTRIBUTING.md - #31

Open
martinsumner wants to merge 1 commit into
openriak-3.4from
nhse-o34-or.i30-contributing
Open

Create CONTRIBUTING.md#31
martinsumner wants to merge 1 commit into
openriak-3.4from
nhse-o34-or.i30-contributing

Conversation

@martinsumner

Copy link
Copy Markdown
Contributor

Draft guideline for contributing.

Draft guideline for contributing.
@martinsumner

Copy link
Copy Markdown
Contributor Author

Draft for comment - @aef- @WarpEngineer @tburghart @hmmr

Comment thread CONTRIBUTING.md
If feedback is not received on the proposal, then please escalate via the `open-riak` channel on the Erlang Ecosystem Foundation Slack channel.

Note that without positive feedback, it may be difficult to pass any proposal through the PR review stage. It is easier to find maintainer review-time for PRs in support of proposals with a broad consensus.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would insert the following paragraph here:

If, and once, a sufficient amount of feedback has been collected, and consensus is reached on all major points of a proposal, the author can proceed to Stage 2 with reasonable assurance that no more substantive objections to their work can arise.

This is to guard against objections in principle coming too late, after Discussion stage is formally ended. Such objections can potentially derail an effort behind the proposal and lead to much friction, frustration and unhappiness.

Comment thread CONTRIBUTING.md
- Reference; reference to any issues or PRs raised for the feature (to be added later).
- Planned Release for Inclusion.

If feedback is not received on the proposal, then please escalate via the `open-riak` channel on the Erlang Ecosystem Foundation Slack channel.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not public, and how to join is not clear at all. Maybe add a line saying "Sign up for a free EEF Basic membership here, and request access to Slack via the member portal."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add the instructions to join in the primary Riak README instead. There are already some lines towards the bottom which we can add to.

Comment thread CONTRIBUTING.md
involved.
```

See http://developercertificate.org/ for a copy of the Developer Certificate of Origin license.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See http://developercertificate.org/ for a copy of the Developer Certificate of Origin license.
See https://developercertificate.org/ for a copy of the Developer Certificate of Origin license.

@WarpEngineer

Copy link
Copy Markdown
Member

So we don't want to explicitly call out AI contributions? The 4 clauses technically should cover it.

@hmmr

hmmr commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

This was my attempt to clarify the use of AI in contributions:

(e) If any sort of AI was used to write substantive portions
    of a contribution, the human person submitting it must:
  (1) provide a description of the session in which their
      contribution was created, at least including the model(s)
      and harness(es) used and prompts given, which should be
      sufficient for others to recreate it independently.
  (2) provide, to all significant parts of a contribution
      (such as functions or modules), meaningful in-line
      human-written comments sufficiently explaining why
      that part is written in this particular way, for others
      to be able to read, understand and reason about relevant
      parts of the code, and maintain it in future.
  (3) use their own, actual email and user name in all commits.

@WarpEngineer

Copy link
Copy Markdown
Member

I like it. We should put something like that in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants